Information about taxi orders for the report

This request is used to collect information about taxi orders for the report.

Request syntax

POST https://b2b-api.go.yandex.ru/integration/2.0/orders/taxi/report

Request headers

Authorization: Bearer <OAuth-token>
OAuth access token. The steps to get a token are described in Getting started.

X-YaTaxi-Selected-Corp-Client-Id — client ID from the account. Required if multiple clients are available using the token.

Accept-Language — set language as a string (ru-RU, en-US, etc.)

Request body

Data is passed in the request body in JSON format:

Field	Description	Format	Required
`ids`	Array of order IDs for which information is needed. No more than 100 IDs.	Array of strings	Yes

Response field description

Responses contain the following field:

Field	Description	Format
`orders`	Array of TaxiOrderInfo objects, each object contains information about an order.	Array of objects

Structure of the TaxiOrderInfo object:

Field	Description	Format
`id`	The order ID.	String
`agency_fee_percent`	Agency fee, percentage.	Number
`agency_to_pay`	Agency fee including VAT.	Number
`agency_without_vat_to_pay`	Agency fee without VAT.	Number
`booking_actual_hours`	Number of actual hours.	Number
`booking_hour_price`	The cost of 1 hour.	Number
`booking_hours`	Number of planned hours.	Number
`cancel_reason`	The reason for the cancellation of the order. The CancelReason object.	Object
`city`	City.	String
`comment`	Comment on the order.	String
`cost`	The cost of the order.	Number
`cost_center`	Cost center.	String
`cost_w_vat`	The cost of the order with VAT.	Number
`created_time`	The time of the order creation.	String
`creator`	Initiator of the order.	String
`department`	Department.	String
`department_path`	Hierarchy of higher-level divisions for the department.	String
`destination`	Coordinates of the destination of the order. An array of two numbers.	Array of numbers
`destination_fullname`	Destination address.	String
`discount`	Discount percentage.	Number
`discounted_cost`	Cost of order with discount.	Number
`distance`	The length of the trip.	Number
`due_datetime`	Order time.	String
`finish_datetime`	Actual time when the trip was completed.	String
`interim_destinations`	Intermediate points of the trip. Array of the InterimDestinationItem objects.	Array of objects
`local_created_datetime`	The local date and time of the order creation.	String
`local_due_datetime`	Local order completion date and time.	String
`old_department`	The employee's department at the time of the order.	String
`order_method`	The order method. For example, "Personal Account".	String
`order_type`	Order type. The OrderType object.	Object
`park_name`	Taxi company.	String
`receipt_url`	Receipt for the trip.	String
`requirements`	Additional requirements that were specified in the order. Array of the requirements objects.	Array of objects
`ride_cost`	The cost of the trip.	Number
`ride_status`	The status of the trip. The RideStatus object.	Object
`sales_tax`	The amount of the sales tax.	Number
`source_fullname`	The starting point of the trip.	String
`source_geopoint`	Coordinates of the starting point of the trip. An array of two numbers.	Array of numbers
`start_datetime`	Actual start of the trip.	String
`start_waiting_datetime`	Actual time of arrival of the car.	String
`tariff_class`	Tariff.	String
`toll_road_cost`	The cost of driving on toll roads.	Number
`total_cost`	Total cost of the order with VAT.	Number
`user_id`	The user's ID.	String
`vat`	VAT.	Number
`waiting_cost`	The cost of waiting.	Number
`waiting_in_depart_time`	Waiting time at the start point of the trip.	Number
`waiting_in_transit_time`	Waiting time at intermediate points.	Number

Structure of the CancelReason object:

Field	Description	Format
`text`	Localized text to display.	String
`value`	One of the reasons: `client_did_not_come`, `a_lot_of_passengers`, `passenger_with_child`, `wrong_address`, `client_cancelled_driving`, `waiting`, `mistaken`, `wrong_pickup`, `wrong_pickup_driver`, `other`.	String

Structure of the InterimDestinationItem object:

Field	Description	Format
`fullname`	he full address of the intermediate point of the route.	String
`geopoint`	Coordinates of the intermediate point. An array of two numbers.	Array of numbers

Structure of the OrderType object:

Field	Description	Format
`text`	Localized text to display.	String
`value`	One of the types: `combo_order`, `booking`.	String

Structure of the requirements object:

Field	Description	Format
`name`	Description of requirements.	String

Structure of the RideStatus object:

Field	Description	Format
`text`	Localized text to display.	String
`value`	One of the statuses: `client_cancelled`, `driver_cancelled`, `complete`.	String

Request example

POST https://b2b-api.go.yandex.ru/integration/2.0/orders/taxi/report
...
Accept-Language: en-US
Authorization: <OAuth-token>

    {
        "ids": [
            "1df3...e600",
            "8d66...2781",
            "1fd4...b9df1"
        ]
    }

Response example

{
    "orders": [
        {
            "id": "1df32d5b8bdcc769b9a2e190933fe600",
            "agency_to_pay": 1.2,
            "agency_without_vat_to_pay": 1.0,
            "cancel_reason": {
                "value": "client_cancelled_driving",
                "text": "Cancellation of the order after the start of the paid pick-up time"
            },
            "city": "Moscow",
            "cost": 0.0,
            "cost_center": "new",
            "cost_w_vat": 0.0,
            "created_datetime": "2022-06-09T18:22:42+03:00",
            "destination": [
                37.58041085337755,
                55.807367818950475
            ],
            "destination_fullname": "95 Butyrskaya Street, Moscow, Russia",
            "discount": 0.0,
            "discounted_cost": 0.0,
            "due_datetime": "2022-06-09T18:23:52+03:00",
            "local_created_datetime": "2022-06-09T18:22:42+03:00",
            "local_due_datetime": "2022-06-09T18:23:52+03:00",
            "old_department": "expenses",
            "order_method": "Mobile application",
            "requirements": [
                {
                    "name": "child safety seat from 3 to 7 years old (15-25 kg)"
                },
                {
                    "name": "Hour+"
                }
            ],  
            "ride_cost": 0.0,
            "ride_status": {
                "value": "client_cancelled",
                "text": "Cancelled by client"
            },
            "sales_tax": 0.0,
            "source_fullname": "18 Fonvizina Street, Moscow, Russia",
            "source_geopoint": [
                37.59143138528312,
                55.82111264677945
            ],
            "tariff_class": "Econom",
            "total_cost": 0.0,
            "user_id": "4550...ba80",
            "vat": 0
        },
        ...
    ]
}

Response codes

The response to this request may contain the following standard HTTP codes:

200: Request completed successfully.
400: An unknown parameter or a parameter with an invalid value was passed in the request.
403:
- SELECT_CLIENT_HEADER_REQUIRED: the request did not pass the header X-YaTaxi-Selected-Corp-Client-Id (returned if more than one client is available for the token).
- SELECTED_CLIENT_ACCESS_DENIED: the header X-YaTaxi-Selected-Corp-Client-Id contains the client's ID, which this login does not have access to.

Was the article helpful?

Order information

Bulk creation of vehicles